Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ASCII-145] Move apm status to pkg/status/apm #21067

Merged
merged 1 commit into from
Nov 29, 2023

Conversation

GustavoCaso
Copy link
Member

@GustavoCaso GustavoCaso commented Nov 23, 2023

What does this PR do?

Following how the status package fetches the process agent status, we are changing how we fetch the APM status.

Rather than doing an extra call from the CLI agent status (Client), we fetch it directly from the agent backend (pkg/status)

That means that CLI no longer has to worry about fetching the APM status or any other status for any other agent process; the backend takes care of fetching everything for it and making the CLI code simpler.

As an added bonus, the GUI was using AJAX to replicate the CLI behaviour; since the GUI is using the pkg/status to fetch that information, we no longer have to maintain that JS code for the GUI. 🔥

Context

Here is the PR that introduced the trace agent status #5235
Here is the PR that added the process agent status #10886

Results

Here is a screenshot of the GUI using the current branch

Screenshot 2023-11-23 at 17 30 54

Here is the output of APM section of agent status

=========
APM Agent
=========
  Status: Running
  Pid: 81185
  Uptime: 42 seconds
  Mem alloc: 11,599,808 bytes
  Hostname: COMP-VQHPF4W6GY
  Receiver: 0.0.0.0:8126
  Endpoints:
    https://trace.agent.datadoghq.eu

  Receiver (previous minute)
  ==========================
    No traces received in the previous minute.


  Writer (previous minute)
  ========================
    Traces: 0 payloads, 0 traces, 0 events, 0 bytes
    Stats: 0 payloads, 0 stats buckets, 0 bytes

Motivation

Additional Notes

Possible Drawbacks / Trade-offs

Describe how to test/QA your changes

Make sure the trace agent and the agent is running.

To enable the trace agent, add this to your configuration:

apm_config:
  enabled: true
  apm_non_local_traffic: true

Once they are running we should validate that:

  • agent status returns the correct information
  • That the APM information is displayed correctly in the GUI. To launch the GUI run agent launch-gui

Reviewer's Checklist

  • If known, an appropriate milestone has been selected; otherwise the Triage milestone is set.
  • Use the major_change label if your change either has a major impact on the code base, is impacting multiple teams or is changing important well-established internals of the Agent. This label will be use during QA to make sure each team pay extra attention to the changed behavior. For any customer facing change use a releasenote.
  • A release note has been added or the changelog/no-changelog label has been applied.
  • Changed code has automated tests for its functionality.
  • Adequate QA/testing plan information is provided if the qa/skip-qa label is not applied.
  • At least one team/.. label has been applied, indicating the team(s) that should QA this change.
  • If applicable, docs team has been notified or an issue has been opened on the documentation repo.
  • If applicable, the need-change/operator and need-change/helm labels have been applied.
  • If applicable, the k8s/<min-version> label, indicating the lowest Kubernetes version compatible with this feature.
  • If applicable, the config template has been updated.

Copy link

cit-pr-commenter bot commented Nov 23, 2023

Go Package Import Differences

Baseline: 9e07eb9
Comparison: bbdb504

binaryosarchchange
agentlinuxamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/status/apm
agentlinuxarm64
+1, -0
+github.com/DataDog/datadog-agent/pkg/status/apm
agentwindowsamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/status/apm
agentwindows386
+1, -0
+github.com/DataDog/datadog-agent/pkg/status/apm
agentdarwinamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/status/apm
agentdarwinarm64
+1, -0
+github.com/DataDog/datadog-agent/pkg/status/apm
iot-agentlinuxamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/status/apm
iot-agentlinuxarm64
+1, -0
+github.com/DataDog/datadog-agent/pkg/status/apm
heroku-agentlinuxamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/status/apm
cluster-agentlinuxamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/status/apm
cluster-agentlinuxarm64
+1, -0
+github.com/DataDog/datadog-agent/pkg/status/apm
cluster-agent-cloudfoundrylinuxamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/status/apm
cluster-agent-cloudfoundrylinuxarm64
+1, -0
+github.com/DataDog/datadog-agent/pkg/status/apm
security-agentlinuxamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/status/apm
security-agentlinuxarm64
+1, -0
+github.com/DataDog/datadog-agent/pkg/status/apm

@GustavoCaso GustavoCaso force-pushed the move-apm-status-to-status-pkg branch 2 times, most recently from da6b054 to 3e8f56f Compare November 23, 2023 16:06
@GustavoCaso GustavoCaso changed the title Move apm status to status pkg Move apm status to pkg/status/apm Nov 23, 2023
@GustavoCaso GustavoCaso changed the title Move apm status to pkg/status/apm [ASCII-145] Move apm status to pkg/status/apm Nov 23, 2023
@GustavoCaso GustavoCaso added this to the 7.51.0 milestone Nov 23, 2023
@GustavoCaso GustavoCaso marked this pull request as ready for review November 23, 2023 16:45
@GustavoCaso GustavoCaso requested review from a team as code owners November 23, 2023 16:45
@pr-commenter
Copy link

pr-commenter bot commented Nov 23, 2023

Bloop Bleep... Dogbot Here

Regression Detector Results

Run ID: a552b2cf-c8f2-4153-905a-23fdceef30fe
Baseline: 9e07eb9
Comparison: bbdb504
Total datadog-agent CPUs: 7

Explanation

A regression test is an integrated performance test for datadog-agent in a repeatable rig, with varying configuration for datadog-agent. What follows is a statistical summary of a brief datadog-agent run for each configuration across SHAs given above. The goal of these tests are to determine quickly if datadog-agent performance is changed and to what degree by a pull request.

Because a target's optimization goal performance in each experiment will vary somewhat each time it is run, we can only estimate mean differences in optimization goal relative to the baseline target. We express these differences as a percentage change relative to the baseline target, denoted "Δ mean %". These estimates are made to a precision that balances accuracy and cost control. We represent this precision as a 90.00% confidence interval denoted "Δ mean % CI": there is a 90.00% chance that the true value of "Δ mean %" is in that interval.

We decide whether a change in performance is a "regression" -- a change worth investigating further -- if both of the following two criteria are true:

  1. The estimated |Δ mean %| ≥ 5.00%. This criterion intends to answer the question "Does the estimated change in mean optimization goal performance have a meaningful impact on your customers?". We assume that when |Δ mean %| < 5.00%, the impact on your customers is not meaningful. We also assume that a performance change in optimization goal is worth investigating whether it is an increase or decrease, so long as the magnitude of the change is sufficiently large.

  2. Zero is not in the 90.00% confidence interval "Δ mean % CI" about "Δ mean %". This statement is equivalent to saying that there is at least a 90.00% chance that the mean difference in optimization goal is not zero. This criterion intends to answer the question, "Is there a statistically significant difference in mean optimization goal performance?". It also means there is no more than a 10.00% chance this criterion reports a statistically significant difference when the true difference in mean optimization goal is zero -- a "false positive". We assume you are willing to accept a 10.00% chance of inaccurately detecting a change in performance when no true difference exists.

The table below, if present, lists those experiments that have experienced a statistically significant change in mean optimization goal performance between baseline and comparison SHAs with 90.00% confidence OR have been detected as newly erratic. Negative values of "Δ mean %" mean that baseline is faster, whereas positive values of "Δ mean %" mean that comparison is faster. Results that do not exhibit more than a ±5.00% change in their mean optimization goal are discarded. An experiment is erratic if its coefficient of variation is greater than 0.1. The abbreviated table will be omitted if no interesting change is observed.

No interesting changes in experiment optimization goals with confidence ≥ 90.00% and |Δ mean %| ≥ 5.00%.

Fine details of change detection per experiment.
experiment goal Δ mean % Δ mean % CI confidence
otel_to_otel_logs ingress throughput +0.22 [-1.36, +1.80] 17.90%
file_to_blackhole egress throughput +0.09 [-0.92, +1.11] 11.83%
tcp_dd_logs_filter_exclude ingress throughput +0.03 [-0.11, +0.17] 23.32%
trace_agent_msgpack ingress throughput +0.02 [-0.11, +0.14] 16.52%
dogstatsd_string_interner_8MiB_1k ingress throughput +0.01 [-0.09, +0.11] 16.82%
dogstatsd_string_interner_8MiB_100k ingress throughput +0.01 [-0.05, +0.07] 22.53%
uds_dogstatsd_to_api ingress throughput +0.01 [-0.17, +0.19] 7.67%
dogstatsd_string_interner_64MiB_1k ingress throughput +0.00 [-0.13, +0.13] 1.29%
dogstatsd_string_interner_128MiB_100 ingress throughput +0.00 [-0.14, +0.14] 0.82%
dogstatsd_string_interner_64MiB_100 ingress throughput +0.00 [-0.14, +0.14] 0.13%
dogstatsd_string_interner_128MiB_1k ingress throughput -0.00 [-0.14, +0.14] 0.11%
dogstatsd_string_interner_8MiB_100 ingress throughput -0.00 [-0.13, +0.12] 3.43%
idle egress throughput -0.01 [-2.46, +2.45] 0.35%
dogstatsd_string_interner_8MiB_50k ingress throughput -0.01 [-0.07, +0.05] 18.24%
dogstatsd_string_interner_8MiB_10k ingress throughput -0.02 [-0.08, +0.04] 44.55%
trace_agent_json ingress throughput -0.03 [-0.16, +0.10] 31.11%
file_tree egress throughput -0.19 [-2.03, +1.64] 13.80%
tcp_syslog_to_blackhole ingress throughput -0.69 [-0.82, -0.56] 100.00%

Copy link
Member

@truthbk truthbk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! 🚀

<span class="stat_title">APM</span>
<span class="stat_data">Loading...</span>
<span class="stat_data">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🍰 way better

pkg/status/apm/apm.go Outdated Show resolved Hide resolved
pkg/status/apm/apm.go Show resolved Hide resolved
pkg/status/status.go Show resolved Hide resolved
@GustavoCaso GustavoCaso force-pushed the move-apm-status-to-status-pkg branch from 3e8f56f to ca13f55 Compare November 28, 2023 09:54
@GustavoCaso GustavoCaso force-pushed the move-apm-status-to-status-pkg branch 2 times, most recently from 880fb5a to 3e90daf Compare November 29, 2023 09:35
- Handle communicating with the trace-agent in the status package
- Update the GUI to rende the apmStats using the informatoin from the server rather than using AJAX
@GustavoCaso GustavoCaso force-pushed the move-apm-status-to-status-pkg branch from 3e90daf to bbdb504 Compare November 29, 2023 09:36
@GustavoCaso GustavoCaso merged commit d13e6ec into main Nov 29, 2023
134 of 137 checks passed
@GustavoCaso GustavoCaso deleted the move-apm-status-to-status-pkg branch November 29, 2023 14:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants